介紹 Docs 轉 Api Blueprint 的整體流程架構與相關服務。
今日要點:
》API篇介紹
這系列要處理的任務是把 Google 文件的 API 描述,透過 Google Apps Script 平台使用 Google 所提供 API,轉成 Api Blueprint 的特別 markdown 格式,再用 Apiary 載入去展示出來給工程師查閱。
Google 所提供 API 功能十分豐富,目前只先介紹這次系列會用到的 API,其他的 API 之後有機會再持續的補充上來。
會使用到的 API 有:
Sheets Service 這個 API 其實這系列可以不用使用到,純粹是轉換成 Sheets 方便 Debug 使用,如果有格式欄位值檢查的需求就可以用到,這次也可以筆記一下。
Docs 轉 Api Blueprint 的整體流程架構大致如下圖所示:
透過 Google Apps Script 平台,能自動讀取 Docs 裡的表格內容進行轉換後,就可以把 Docs 文件當成主要的文件來維護,再依需要轉成對應的檔案格式,可以大幅減少工程師們的負擔。
明天開始介紹 Drive Service 吧。